Decode Composite QR Code

Decode Composite QR code

Decoding a composite QR code will use the same endpoints as decoding a normal Pix QR code

Request

POST 'https://apisandbox.delbank.com.br/baas/api/v2/pix/qrcode/payment-initialization'

Headers

Name	Description
x-delbank-api-key	Required. API key

Body

{
    "payload": "00020101021226850014br.gov.bcb.pix2563pix-h.delbank.com.br/v1/qrcode/charge3rRpryWmbSbn0FxuhHDeF4ngLE5204000053039865802BR5925HOMOLOGACAO INTEGRACAO AP6007ARACAJU62070503***63049D66"
}

Response Fields

Name	Type	Description
key	string	Pix key
endToEndId	string	EndToEndId for the initiated payment
correlationId	string	Correlation identifier
transactionId	string	Transaction identifier
payerQuestion	string	Message shown to the payer
expirationTime	integer	QR code expiration time
revision	integer	Revision
allowChangeAmount	boolean	Indicates whether changing amount is allowed
categoryCode	string	Category code
createdAt	string	Creation datetime in UTC (ISO 8601)
capturedAt	string	Capture datetime in UTC (ISO 8601)
type	enum	QR code type
initiationType	enum	Initiation type
status	enum	QR code status
amount	number	Amount
originalAmount	number	Original amount
fineAmount	number	Fine amount
feesAmount	number	Fees amount
discountAmount	number	Discount amount
rebateAmount	number	Rebate amount
dueDate	string	Due date
paymentDeadline	integer	Payment deadline
payer	object	Payer data
payer.name	string	Payer name
payer.document	string	Payer document
payer.validate	boolean	Indicates whether payer validation is enabled
bankAccountRecipient	object	Recipient bank account
bankAccountRecipient.number	string	Account number
bankAccountRecipient.branch	string	Branch
bankAccountRecipient.type	enum	Account type. Domains: PAYMENT CURRENT SAVING SALARY
bankAccountRecipient.bank	object	Bank info
bankAccountRecipient.bank.name	string	Bank name
bankAccountRecipient.bank.ispbCode	string	Bank ISPB code
bankAccountRecipient.holder	object	Account holder
bankAccountRecipient.holder.name	string	Holder name
bankAccountRecipient.holder.document	string	Holder document
bankAccountRecipient.holder.type	enum	Holder person type
beneficiary	object	Beneficiary account data
additionalInfos	array	Additional information
additionalInfos.name	string	Name
additionalInfos.value	string	Value
recipientId	string	Recipient identifier
decodeType	enum	Decode type. Domains: QR_CODE_STATIC QR_CODE_IMMEDIATE QR_CODE_DUE_DATE RECURRENCE RECURRENCE_STATIC RECURRENCE_IMMEDIATE RECURRENCE_DUE_DATE
recurrence	object	Recurrence data
recurrence.id	string	Recurrence id
recurrence.revision	integer	Recurrence revision
recurrence.journey	integer	Journey
recurrence.frequencyType	enum	Frequency type. Domains: WEEKLY MONTHLY QUARTERLY SEMIANNUAL ANNUAL
recurrence.recurrenceStartDate	string	Recurrence start date
recurrence.recurrenceEndDate	string	Recurrence end date
recurrence.amount	number	Amount
recurrence.minPayerMaxAmount	number	Minimum allowed for payer's max amount
recurrence.beneficiary	object	Beneficiary data
recurrence.beneficiary.ispb	string	Beneficiary ISPB
recurrence.beneficiary.document	string	Beneficiary document
recurrence.beneficiary.name	string	Beneficiary name
recurrence.debtor	object	Debtor data
recurrence.debtor.type	enum	Person type
recurrence.debtor.document	string	Debtor document
recurrence.debtor.name	string	Debtor name
recurrence.contractNumber	string	Contract number
recurrence.contractDescription	string	Contract description
recurrence.retryCount	integer	Retry count
recurrence.updates	array	Update list
recurrence.updates.recurrenceStatus	integer	Recurrence status
recurrence.updates.statusDateTime	string	Status datetime
recurrence.updates.createdAt	string	Created at
recurrence.updates.presentationAt	string	Presentation at
recurrence.receiverPspUrl	string	Receiver PSP URL

Response example

{
  "key": "4a28c57d-3fdc-4d1d-99a7-38ce5e574292",
  "endToEndId": "E3822485720260422135161U0X5D1POK",
  "transactionId": "vcharge63c589259ef54f",
  "allowChangeAmount": false,
  "categoryCode": "0000",
  "type": "COMPOSITE",
  "amount": 100.01,
  "originalAmount": 100.01,
  "bankAccountRecipient": {
    "number": "9999999",
    "branch": "0001",
    "type": "CURRENT",
    "bank": {
      "name": "DELBANK",
      "ispbCode": "38224857"
    },
    "holder": {
      "name": "DELCRED SOCIEDADE DE CREDITO DIRETO S.A",
      "document": "38224857000168",
      "type": "LEGAL"
    }
  },
  "recipientId": "vcharge63c589259ef54f",
  "decodeType": "RECURRENCE_STATIC",
  "recurrence": {
    "id": "RR3822485720260422ea5db4dada6",
    "journey": 4,
    "frequencyType": "MONTHLY",
    "recurrenceStartDate": "2025-10-23",
    "recurrenceEndDate": "2026-01-10",
    "amount": 100.0,
    "beneficiary": {
      "ispb": "38224857",
      "document": "03284584000162",
      "name": "DELCRED SOCIEDADE DE CREDITO DIRETO S.A"
    },
    "debtor": {
      "type": "NATURAL",
      "document": "04623217035",
      "name": "Ciclano da Silva"
    },
    "contractNumber": "1234567890ABC",
    "contractDescription": "Conta de energia",
    "retryCount": 1,
    "updates": [
      {
        "recurrenceStatus": 0,
        "statusDateTime": "2026-04-22T10:50:19.409Z"
      }
    ],
    "receiverPspUrl": "pix-h.delbank.com.br/v1/rec/vcharge63c589259ef54f"
  }
}